/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.beanutils;
import java.util.*;
import java.lang.ref.WeakReference;
import java.lang.ref.ReferenceQueue;
import junit.framework.TestCase;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.commons.logging.LogFactory;
/**
* <p>
* Test Case for changes made during Beanutils Beanification
* </p>
*
* @author Robert Burrell Donkin
* @author Juozas Baliuka
* @version $Revision: 469737 $ $Date: 2006-11-01 01:16:55 +0000 (Wed, 01 Nov 2006) $
*/
public class BeanificationTestCase extends TestCase {
// ---------------------------------------------------- Constants
/** Maximum number of iterations before our test fails */
public static final int MAX_GC_ITERATIONS = 50;
// ---------------------------------------------------- Instance Variables
// ---------------------------------------------------------- Constructors
/**
* Construct a new instance of this test case.
*
* @param name Name of the test case
*/
public BeanificationTestCase(String name) {
super(name);
}
// -------------------------------------------------- Overall Test Methods
/**
* Set up instance variables required by this test case.
*/
public void setUp() {
ConvertUtils.deregister();
}
/**
* Return the tests included in this test suite.
*/
public static Test suite() {
return (new TestSuite(BeanificationTestCase.class));
}
/**
* Tear down instance variables required by this test case.
*/
public void tearDown() {
// No action required
}
// ------------------------------------------------ Individual Test Methods
/** Test of the methodology we'll use for some of the later tests */
public void testMemoryTestMethodology() throws Exception {
// test methodology
// many thanks to Juozas Baliuka for suggesting this method
ClassLoader loader = new ClassLoader(this.getClass().getClassLoader()) {};
WeakReference reference = new WeakReference(loader);
Class myClass = loader.loadClass("org.apache.commons.beanutils.BetaBean");
assertNotNull("Weak reference released early", reference.get());
// dereference class loader and class:
loader = null;
myClass = null;
int iterations = 0;
int bytz = 2;
while(true) {
System.gc();
if(iterations++ > MAX_GC_ITERATIONS){
fail("Max iterations reached before resource released.");
}
if( reference.get() == null ) {
break;
} else {
// create garbage:
byte[] b = new byte[bytz];
bytz = bytz * 2;
}
}
}
/** Tests whether classloaders and beans are released from memory by the map used by beanutils */
public void testMemoryLeak2() throws Exception {
// tests when the map used by beanutils has the right behaviour
if (isPre14JVM()) {
System.out.println("WARNING: CANNOT TEST MEMORY LEAK ON PRE1.4 JVM");
return;
}
// many thanks to Juozas Baliuka for suggesting this methodology
TestClassLoader loader = new TestClassLoader();
ReferenceQueue queue = new ReferenceQueue();
WeakReference loaderReference = new WeakReference(loader, queue);
Integer test = new Integer(1);
WeakReference testReference = new WeakReference(test, queue);
//Map map = new ReferenceMap(ReferenceMap.WEAK, ReferenceMap.HARD, true);
Map map = new WeakHashMap();
map.put(loader, test);
assertEquals("In map", test, map.get(loader));
assertNotNull("Weak reference released early (1)", loaderReference.get());
assertNotNull("Weak reference released early (2)", testReference.get());
// dereference strong references
loader = null;
test = null;
int iterations = 0;
int bytz = 2;
while(true) {
System.gc();
if(iterations++ > MAX_GC_ITERATIONS){
fail("Max iterations reached before resource released.");
}
map.isEmpty();
if(
loaderReference.get() == null &&
testReference.get() == null) {
break;
} else {
// create garbage:
byte[] b = new byte[bytz];
bytz = bytz * 2;
}
}
}
/** Tests whether classloaders and beans are released from memory */
public void testMemoryLeak() throws Exception {
if (isPre14JVM()) {
System.out.println("WARNING: CANNOT TEST MEMORY LEAK ON PRE1.4 JVM");
return;
}
// many thanks to Juozas Baliuka for suggesting this methodology
TestClassLoader loader = new TestClassLoader();
WeakReference loaderReference = new WeakReference(loader);
BeanUtilsBean.getInstance();
class GetBeanUtilsBeanThread extends Thread {
BeanUtilsBean beanUtils;
ConvertUtilsBean convertUtils;
PropertyUtilsBean propertyUtils;
GetBeanUtilsBeanThread() {}
public void run() {
beanUtils = BeanUtilsBean.getInstance();
convertUtils = ConvertUtilsBean.getInstance();
propertyUtils = PropertyUtilsBean.getInstance();
// XXX Log keeps a reference around!
LogFactory.releaseAll();
}
public String toString() {
return "GetBeanUtilsBeanThread";
}
}
GetBeanUtilsBeanThread thread = new GetBeanUtilsBeanThread();
WeakReference threadWeakReference = new WeakReference(thread);
thread.setContextClassLoader(loader);
thread.start();
thread.join();
WeakReference beanUtilsReference = new WeakReference(thread.beanUtils);
WeakReference propertyUtilsReference = new WeakReference(thread.propertyUtils);
WeakReference convertUtilsReference = new WeakReference(thread.convertUtils);
assertNotNull("Weak reference released early (1)", loaderReference.get());
assertNotNull("Weak reference released early (2)", beanUtilsReference.get());
assertNotNull("Weak reference released early (3)", propertyUtilsReference.get());
assertNotNull("Weak reference released early (4)", convertUtilsReference.get());
// dereference strong references
loader = null;
thread.setContextClassLoader(null);
thread = null;
int iterations = 0;
int bytz = 2;
while(true) {
BeanUtilsBean.getInstance();
System.gc();
if(iterations++ > MAX_GC_ITERATIONS){
fail("Max iterations reached before resource released.");
}
if(
loaderReference.get() == null &&
beanUtilsReference.get() == null &&
propertyUtilsReference.get() == null &&
convertUtilsReference.get() == null) {
break;
} else {
// create garbage:
byte[] b = new byte[bytz];
bytz = bytz * 2;
}
}
}
/**
* Tests whether difference instances are loaded by different
* context classloaders.
*/
public void testGetByContextClassLoader() throws Exception {
class GetBeanUtilsBeanThread extends Thread {
private Signal signal;
GetBeanUtilsBeanThread(Signal signal) {
this.signal = signal;
}
public void run() {
signal.setSignal(2);
signal.setBean(BeanUtilsBean.getInstance());
signal.setConvertUtils(ConvertUtilsBean.getInstance());
signal.setPropertyUtils(PropertyUtilsBean.getInstance());
}
public String toString() {
return "GetBeanUtilsBeanThread";
}
}
Signal signal = new Signal();
signal.setSignal(1);
GetBeanUtilsBeanThread thread = new GetBeanUtilsBeanThread(signal);
thread.setContextClassLoader(new TestClassLoader());
thread.start();
thread.join();
assertEquals("Signal not set by test thread", 2, signal.getSignal());
assertTrue(
"Different BeanUtilsBean instances per context classloader",
BeanUtilsBean.getInstance() != signal.getBean());
assertTrue(
"Different ConvertUtilsBean instances per context classloader",
ConvertUtilsBean.getInstance() != signal.getConvertUtils());
assertTrue(
"Different PropertyUtilsBean instances per context classloader",
PropertyUtilsBean.getInstance() != signal.getPropertyUtils());
}
/**
* Tests whether difference instances are loaded by different
* context classloaders.
*/
public void testContextClassLoaderLocal() throws Exception {
class CCLLTesterThread extends Thread {
private Signal signal;
private ContextClassLoaderLocal ccll;
CCLLTesterThread(Signal signal, ContextClassLoaderLocal ccll) {
this.signal = signal;
this.ccll = ccll;
}
public void run() {
ccll.set(new Integer(1789));
signal.setSignal(2);
signal.setMarkerObject(ccll.get());
}
public String toString() {
return "CCLLTesterThread";
}
}
ContextClassLoaderLocal ccll = new ContextClassLoaderLocal();
ccll.set(new Integer(1776));
assertEquals("Start thread sets value", new Integer(1776), ccll.get());
Signal signal = new Signal();
signal.setSignal(1);
CCLLTesterThread thread = new CCLLTesterThread(signal, ccll);
thread.setContextClassLoader(new TestClassLoader());
thread.start();
thread.join();
assertEquals("Signal not set by test thread", 2, signal.getSignal());
assertEquals("Second thread preserves value", new Integer(1776), ccll.get());
assertEquals("Second thread gets value it set", new Integer(1789), signal.getMarkerObject());
}
/** Tests whether calls are independent for different classloaders */
public void testContextClassloaderIndependence() throws Exception {
class TestIndependenceThread extends Thread {
private Signal signal;
private PrimitiveBean bean;
TestIndependenceThread(Signal signal, PrimitiveBean bean) {
this.signal = signal;
this.bean = bean;
}
public void run() {
try {
signal.setSignal(3);
ConvertUtils.register(new Converter() {
public Object convert(Class type, Object value) {
return new Integer(9);
}
}, Integer.TYPE);
BeanUtils.setProperty(bean, "int", new Integer(1));
} catch (Exception e) {
e.printStackTrace();
signal.setException(e);
}
}
public String toString() {
return "TestIndependenceThread";
}
}
PrimitiveBean bean = new PrimitiveBean();
BeanUtils.setProperty(bean, "int", new Integer(1));
assertEquals("Wrong property value (1)", 1, bean.getInt());
ConvertUtils.register(new Converter() {
public Object convert(Class type, Object value) {
return new Integer(5);
}
}, Integer.TYPE);
BeanUtils.setProperty(bean, "int", new Integer(1));
assertEquals("Wrong property value(2)", 5, bean.getInt());
Signal signal = new Signal();
signal.setSignal(1);
TestIndependenceThread thread = new TestIndependenceThread(signal, bean);
thread.setContextClassLoader(new TestClassLoader());
thread.start();
thread.join();
assertNull("Exception thrown by test thread:" + signal.getException(), signal.getException());
assertEquals("Signal not set by test thread", 3, signal.getSignal());
assertEquals("Wrong property value(3)", 9, bean.getInt());
}
/** Tests whether different threads can set beanutils instances correctly */
public void testBeanUtilsBeanSetInstance() throws Exception {
class SetInstanceTesterThread extends Thread {
private Signal signal;
private BeanUtilsBean bean;
SetInstanceTesterThread(Signal signal, BeanUtilsBean bean) {
this.signal = signal;
this.bean = bean;
}
public void run() {
BeanUtilsBean.setInstance(bean);
signal.setSignal(21);
signal.setBean(BeanUtilsBean.getInstance());
}
public String toString() {
return "SetInstanceTesterThread";
}
}
Signal signal = new Signal();
signal.setSignal(1);
BeanUtilsBean beanOne = new BeanUtilsBean();
BeanUtilsBean beanTwo = new BeanUtilsBean();
SetInstanceTesterThread thread = new SetInstanceTesterThread(signal, beanTwo);
thread.setContextClassLoader(new TestClassLoader());
BeanUtilsBean.setInstance(beanOne);
assertEquals("Start thread gets right instance", beanOne, BeanUtilsBean.getInstance());
thread.start();
thread.join();
assertEquals("Signal not set by test thread", 21, signal.getSignal());
assertEquals("Second thread preserves value", beanOne, BeanUtilsBean.getInstance());
assertEquals("Second thread gets value it set", beanTwo, signal.getBean());
}
/** Tests whether the unset method works*/
public void testContextClassLoaderUnset() throws Exception {
BeanUtilsBean beanOne = new BeanUtilsBean();
ContextClassLoaderLocal ccll = new ContextClassLoaderLocal();
ccll.set(beanOne);
assertEquals("Start thread gets right instance", beanOne, ccll.get());
ccll.unset();
assertTrue("Unset works", !beanOne.equals(ccll.get()));
}
private boolean isPre14JVM() {
// some pre 1.4 JVM have buggy WeakHashMap implementations
// this is used to test for those JVM
String version = System.getProperty("java.specification.version");
StringTokenizer tokenizer = new StringTokenizer(version,".");
if (tokenizer.nextToken().equals("1")) {
String minorVersion = tokenizer.nextToken();
if (minorVersion.equals("0")) return true;
if (minorVersion.equals("1")) return true;
if (minorVersion.equals("2")) return true;
if (minorVersion.equals("3")) return true;
}
return false;
}
// ---- Auxillary classes
class TestClassLoader extends ClassLoader {
public String toString() {
return "TestClassLoader";
}
}
class Signal {
private Exception e;
private int signal = 0;
private BeanUtilsBean bean;
private PropertyUtilsBean propertyUtils;
private ConvertUtilsBean convertUtils;
private Object marker;
public Exception getException() {
return e;
}
public void setException(Exception e) {
this.e = e;
}
public int getSignal() {
return signal;
}
public void setSignal(int signal) {
this.signal = signal;
}
public Object getMarkerObject() {
return marker;
}
public void setMarkerObject(Object marker) {
this.marker = marker;
}
public BeanUtilsBean getBean() {
return bean;
}
public void setBean(BeanUtilsBean bean) {
this.bean = bean;
}
public PropertyUtilsBean getPropertyUtils() {
return propertyUtils;
}
public void setPropertyUtils(PropertyUtilsBean propertyUtils) {
this.propertyUtils = propertyUtils;
}
public ConvertUtilsBean getConvertUtils() {
return convertUtils;
}
public void setConvertUtils(ConvertUtilsBean convertUtils) {
this.convertUtils = convertUtils;
}
}
}